chore: add checks for schema changes by mentonin · Pull Request #1992 · kernelci/dashboard

mentonin · 2026-07-15T02:12:51Z

Summary

This PR adds a pre-commit hook to check that backend/schema.yml is up-to-date with python manage.py spectacular.

It also adds all pre-commit checks to the CI workflow, replacing duplicated linting/format specifications.

Related Issues

Closes Enforce OpenAPI schema updates in CI #1910

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

This removes code duplication and makes the CI checks consistent with the development environment. Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

alanpeixinho · 2026-07-15T12:05:21Z

@mentonin are we dropping the removal of the schema.yml from versioning?

tales-aparecida · 2026-07-15T18:49:46Z

how come the CI checks are empty?

alanpeixinho · 2026-07-16T15:41:15Z

+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0


wont we need to setup node (and pnpm) to be able to run the frontend linters?

Nice catch. Pre-commit is able to setup isolated environments, including for node, but we are not using that for the frontend checks

alanpeixinho · 2026-07-16T15:44:54Z

-          path: ./dashboard/node_modules
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4


might be needed on pre-commit run?

alanpeixinho · 2026-07-16T15:47:23Z

we are using the old task name here

alanpeixinho · 2026-07-16T15:53:34Z

+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0


might be better to reuse setup-backend
uses: ./.github/actions/setup-backend

We don't need poetry and dependencies, as pre-commit should use its own environment for running tests

alanpeixinho · 2026-07-16T15:54:58Z

  CI: true

 jobs:
+  pre-commit-checks:


might be worth to include timeout just in case

alanpeixinho · 2026-07-16T15:56:46Z

how come the CI checks are empty?

@mentonin we need to include

how come the CI checks are empty?

I believe the CI checks are tracking code changes only (backend or frontend). Is it correct @mentonin?

alanpeixinho · 2026-07-16T17:18:13Z

how come the CI checks are empty?

@mentonin we need to include

how come the CI checks are empty?

I believe the CI checks are tracking code changes only (backend or frontend). Is it correct @mentonin?

My bad, the changes were for pre-commit only.

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

alanpeixinho

LGTM

tales-aparecida · 2026-07-21T19:50:40Z

+      - id: api-schema
+        name: API schema is up-to-date
+        entry: |
+          python -c '
+          import os, subprocess, sys;
+          os.chdir("backend")
+          subprocess.run(["poetry", "install"], capture_output=True)
+          spectacular = subprocess.run(["poetry", "run", "python", "manage.py", "spectacular"], capture_output=True, text=True)
+          new_schema = spectacular.stdout
+          with open("schema.yml") as f:
+              old_schema = f.read()
+          if new_schema != old_schema:
+              print("Schema is not up-to-date. Run \"python manage.py spectacular --file schema.yml\" to regenerate it")
+              sys.exit(1)
+          '
+        files: 'backend/(.*\.py|schema.yml)'
+        pass_filenames: false
+        language: python
+        language_version: '3.12'
+        additional_dependencies: [poetry]
+        stages: [pre-commit]


Any reason to use python+subprocess instead of sh?

Suggested change

- id: api-schema

name: API schema is up-to-date

entry: |

python -c '

import os, subprocess, sys;

os.chdir("backend")

subprocess.run(["poetry", "install"], capture_output=True)

spectacular = subprocess.run(["poetry", "run", "python", "manage.py", "spectacular"], capture_output=True, text=True)

new_schema = spectacular.stdout

with open("schema.yml") as f:

old_schema = f.read()

if new_schema != old_schema:

print("Schema is not up-to-date. Run \"python manage.py spectacular --file schema.yml\" to regenerate it")

sys.exit(1)

'

files: 'backend/(.*\.py|schema.yml)'

pass_filenames: false

language: python

language_version: '3.12'

additional_dependencies: [poetry]

stages: [pre-commit]

- id: api-schema

name: API schema is up-to-date

entry: |

bash -c '

cd backend || exit 1

poetry install --quiet

NEW_SCHEMA=$(poetry run python manage.py spectacular)

OLD_SCHEMA=$(cat schema.yml 2>/dev/null)

if [ "$NEW_SCHEMA" != "$OLD_SCHEMA" ]; then

echo "Schema is not up-to-date. Run \"python manage.py spectacular --file schema.yml\" to regenerate it"

exit 1

fi

'

files: '^backend/(.*\.py|schema\.yml)$'

pass_filenames: false

language: system

stages: [pre-commit]

-- Assisted-by: Gemini

It also warned about poetry install --quiet causing commits to become slow, but I doubt it's a problem

Finally, it suggested using --validate --fail-on-warn instead of diffing the schema

mentonin added 2 commits July 14, 2026 23:06

chore: add pre-commit check for API schema sync

1d4bc5c

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

chore: add pre-commit checks to CI workflow

5589a18

This removes code duplication and makes the CI checks consistent with the development environment. Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

mentonin mentioned this pull request Jul 15, 2026

fix: remove generated schema.yml file from git #1978

Closed

alanpeixinho reviewed Jul 16, 2026

View reviewed changes

mentonin added 2 commits July 20, 2026 10:14

fixup! chore: add pre-commit checks to CI workflow

47ccb66

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

fixup! chore: add pre-commit check for API schema sync

edd0c86

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>

mentonin force-pushed the georg/fix/schema-CI branch from 7ee4186 to edd0c86 Compare July 20, 2026 13:34

alanpeixinho approved these changes Jul 21, 2026

View reviewed changes

tales-aparecida reviewed Jul 21, 2026

View reviewed changes

Uh oh!

Conversation

mentonin commented Jul 15, 2026

Summary

Related Issues

Uh oh!

alanpeixinho commented Jul 15, 2026

Uh oh!

tales-aparecida commented Jul 15, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alanpeixinho commented Jul 16, 2026

Uh oh!

alanpeixinho commented Jul 16, 2026

Uh oh!

alanpeixinho left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants